<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketclient;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.BufferedReader;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.IOException;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.net.SocketException;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.apache.log4j.Logger;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    /**<a name="line.10"></a>
<FONT color="green">011</FONT>     * Worker thread for the client server that is dedicated to the singular server.<a name="line.11"></a>
<FONT color="green">012</FONT>     * &lt;p&gt;<a name="line.12"></a>
<FONT color="green">013</FONT>     * Sets up a child thread that listens for server input, while sending Pong response messages if required and handling messages sent to the<a name="line.13"></a>
<FONT color="green">014</FONT>     * server.<a name="line.14"></a>
<FONT color="green">015</FONT>     * <a name="line.15"></a>
<FONT color="green">016</FONT>     * @author Benny Bottema<a name="line.16"></a>
<FONT color="green">017</FONT>     * @see SwiftSocketClient<a name="line.17"></a>
<FONT color="green">018</FONT>     * @see #pong()<a name="line.18"></a>
<FONT color="green">019</FONT>     * @since 1.0<a name="line.19"></a>
<FONT color="green">020</FONT>     */<a name="line.20"></a>
<FONT color="green">021</FONT>    public class ServerHandler implements Runnable {<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>            /**<a name="line.23"></a>
<FONT color="green">024</FONT>             * Basic logger to log events such as client timeouts and other client related events.<a name="line.24"></a>
<FONT color="green">025</FONT>             */<a name="line.25"></a>
<FONT color="green">026</FONT>            private static final Logger LOGGER = Logger.getLogger(ServerHandler.class);<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>            /**<a name="line.28"></a>
<FONT color="green">029</FONT>             * The length of the message id's of a message string (binary packet).<a name="line.29"></a>
<FONT color="green">030</FONT>             */<a name="line.30"></a>
<FONT color="green">031</FONT>            protected static final int MESSAGEID_LENGTH = 3;<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>            private static final String ERROR_SOCKET_CLOSED = "socket closed";<a name="line.33"></a>
<FONT color="green">034</FONT>            private static final String ERROR_RECV_FAILED = "Software caused connection abort: recv failed";<a name="line.34"></a>
<FONT color="green">035</FONT>            private static final String ERROR_CONNECTION_RESET = "Connection reset";<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>            /**<a name="line.37"></a>
<FONT color="green">038</FONT>             * The {@link SwiftSocketClient} instance used to acquire {@link ClientMessageToServer} messages from.<a name="line.38"></a>
<FONT color="green">039</FONT>             */<a name="line.39"></a>
<FONT color="green">040</FONT>            private final SwiftSocketClient client;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>            /**<a name="line.42"></a>
<FONT color="green">043</FONT>             * The {@link ServerContext} containing all session data concerning the server. Also contains a session data container for external use<a name="line.43"></a>
<FONT color="green">044</FONT>             * only. External users can utilize this container to store server related data for the duration of the connection.<a name="line.44"></a>
<FONT color="green">045</FONT>             */<a name="line.45"></a>
<FONT color="green">046</FONT>            private final ServerContext serverContext;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>            /**<a name="line.48"></a>
<FONT color="green">049</FONT>             * Constructor, which accepts a {@link SwiftSocketClient} instance and a client {@link ServerContext}.<a name="line.49"></a>
<FONT color="green">050</FONT>             * <a name="line.50"></a>
<FONT color="green">051</FONT>             * @param client Client used to check on the client status (ie. client is stopping).<a name="line.51"></a>
<FONT color="green">052</FONT>             * @param serverContext The context containing the server socket to which this worker thread is dedicated to.<a name="line.52"></a>
<FONT color="green">053</FONT>             */<a name="line.53"></a>
<FONT color="green">054</FONT>            protected ServerHandler(final SwiftSocketClient client, final ServerContext serverContext) {<a name="line.54"></a>
<FONT color="green">055</FONT>                    this.client = client;<a name="line.55"></a>
<FONT color="green">056</FONT>                    this.serverContext = serverContext;<a name="line.56"></a>
<FONT color="green">057</FONT>            }<a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>            /**<a name="line.59"></a>
<FONT color="green">060</FONT>             * Logs and sends a message to the server using {@link #serverContext}, delegating the actual sending to<a name="line.60"></a>
<FONT color="green">061</FONT>             * {@link #sendResponse(ServerContext, int, ClientMessageToServer)}, unless the client has said 'Bye Bye' in which case the message to<a name="line.61"></a>
<FONT color="green">062</FONT>             * be sent is ignored altogether.<a name="line.62"></a>
<FONT color="green">063</FONT>             * <a name="line.63"></a>
<FONT color="green">064</FONT>             * @param message The client message to send to the server.<a name="line.64"></a>
<FONT color="green">065</FONT>             * @see ServerContext#isServerSaidByeBye()<a name="line.65"></a>
<FONT color="green">066</FONT>             * @see #sendResponse(ServerContext, int, ClientMessageToServer)<a name="line.66"></a>
<FONT color="green">067</FONT>             */<a name="line.67"></a>
<FONT color="green">068</FONT>            public void sendMessage(final ClientMessageToServer message) {<a name="line.68"></a>
<FONT color="green">069</FONT>                    final Logger messageLogger = determineLogger(message);<a name="line.69"></a>
<FONT color="green">070</FONT>                    messageLogger.debug(String.format("sending message to %s: %s", serverContext.getServerInetAddress(), message.getClass()<a name="line.70"></a>
<FONT color="green">071</FONT>                                    .getSimpleName()));<a name="line.71"></a>
<FONT color="green">072</FONT>                    if (!serverContext.isServerSaidByeBye()) {<a name="line.72"></a>
<FONT color="green">073</FONT>                            final int messageId = client.getClientMessageId(message.getClass());<a name="line.73"></a>
<FONT color="green">074</FONT>                            sendResponse(serverContext, messageId, message);<a name="line.74"></a>
<FONT color="green">075</FONT>                    } else {<a name="line.75"></a>
<FONT color="green">076</FONT>                            // log message, giving class logger priority<a name="line.76"></a>
<FONT color="green">077</FONT>                            Logger availableLogger = LOGGER;<a name="line.77"></a>
<FONT color="green">078</FONT>                            if (!LOGGER.isDebugEnabled() &amp;&amp; messageLogger.isDebugEnabled()) {<a name="line.78"></a>
<FONT color="green">079</FONT>                                    availableLogger = messageLogger;<a name="line.79"></a>
<FONT color="green">080</FONT>                            }<a name="line.80"></a>
<FONT color="green">081</FONT>                            availableLogger.debug(String.format("dropping message %s, reason: server already said byebye", message));<a name="line.81"></a>
<FONT color="green">082</FONT>                    }<a name="line.82"></a>
<FONT color="green">083</FONT>            }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>            /**<a name="line.85"></a>
<FONT color="green">086</FONT>             * Helper method used to send a message to the server.<a name="line.86"></a>
<FONT color="green">087</FONT>             * <a name="line.87"></a>
<FONT color="green">088</FONT>             * @param serverContext The server to send the message to.<a name="line.88"></a>
<FONT color="green">089</FONT>             * @param messageId The message id, known to both the server and the client.<a name="line.89"></a>
<FONT color="green">090</FONT>             * @param message The {@link ClientMessageToServer} used to physically encode the message as &lt;code&gt;String&lt;/code&gt;.<a name="line.90"></a>
<FONT color="green">091</FONT>             */<a name="line.91"></a>
<FONT color="green">092</FONT>            private void sendResponse(final ServerContext serverContext, final int messageId, final ClientMessageToServer message) {<a name="line.92"></a>
<FONT color="green">093</FONT>                    final String paddedMessageId = StringUtils.leftPad(String.valueOf(messageId), MESSAGEID_LENGTH, '0');<a name="line.93"></a>
<FONT color="green">094</FONT>                    final String datagram = String.format("%s%s\n\0", paddedMessageId, message.encode());<a name="line.94"></a>
<FONT color="green">095</FONT>                    try {<a name="line.95"></a>
<FONT color="green">096</FONT>                            serverContext.getServerEndpoint().send(datagram);<a name="line.96"></a>
<FONT color="green">097</FONT>                    } catch (final IOException e) {<a name="line.97"></a>
<FONT color="green">098</FONT>                            throw new RuntimeException(String.format("unable to send message to client %s", serverContext.getServerInetAddress()), e);<a name="line.98"></a>
<FONT color="green">099</FONT>                    }<a name="line.99"></a>
<FONT color="green">100</FONT>            }<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>            /**<a name="line.102"></a>
<FONT color="green">103</FONT>             * Returns the class logger {@link #LOGGER} in case of user defined message types, or a message type specific logger if it is a native<a name="line.103"></a>
<FONT color="green">104</FONT>             * message type. This is so that we're able to differentiate log levels between Ping Pong messages (to mute them effectively) and other<a name="line.104"></a>
<FONT color="green">105</FONT>             * messages we'd still like to see in out logging.<a name="line.105"></a>
<FONT color="green">106</FONT>             * <a name="line.106"></a>
<FONT color="green">107</FONT>             * @param object The object doing the logging.<a name="line.107"></a>
<FONT color="green">108</FONT>             * @return The correct logger to avoid using log4j on end user classes (who may not support log4j and get due warnings) and still be<a name="line.108"></a>
<FONT color="green">109</FONT>             *         able to mute specific native message types, such as {@link ClientMessageToServerPingPong}.<a name="line.109"></a>
<FONT color="green">110</FONT>             */<a name="line.110"></a>
<FONT color="green">111</FONT>            private Logger determineLogger(final Object object) {<a name="line.111"></a>
<FONT color="green">112</FONT>                    final boolean isNativeObject = object.getClass().getPackage() == ServerHandler.class.getPackage();<a name="line.112"></a>
<FONT color="green">113</FONT>                    return (isNativeObject) ? Logger.getLogger(object.getClass()) : LOGGER;<a name="line.113"></a>
<FONT color="green">114</FONT>            }<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>            /**<a name="line.116"></a>
<FONT color="green">117</FONT>             * @return The {@link #serverContext} containing session data for external use.<a name="line.117"></a>
<FONT color="green">118</FONT>             */<a name="line.118"></a>
<FONT color="green">119</FONT>            public ServerContext getServerContext() {<a name="line.119"></a>
<FONT color="green">120</FONT>                    return serverContext;<a name="line.120"></a>
<FONT color="green">121</FONT>            }<a name="line.121"></a>
<FONT color="green">122</FONT>    <a name="line.122"></a>
<FONT color="green">123</FONT>            /**<a name="line.123"></a>
<FONT color="green">124</FONT>             * Called by {@link ServerMessageToClientPingPong#execute(ServerHandler)}. Sends a {@link ClientMessageToServerPingPong} to the server<a name="line.124"></a>
<FONT color="green">125</FONT>             * using {@link #sendMessage(ClientMessageToServer)}.<a name="line.125"></a>
<FONT color="green">126</FONT>             */<a name="line.126"></a>
<FONT color="green">127</FONT>            public void pong() {<a name="line.127"></a>
<FONT color="green">128</FONT>                    sendMessage(new ClientMessageToServerPingPong());<a name="line.128"></a>
<FONT color="green">129</FONT>            }<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>            /*<a name="line.131"></a>
<FONT color="green">132</FONT>             * server input handling<a name="line.132"></a>
<FONT color="green">133</FONT>             */<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>            /**<a name="line.135"></a>
<FONT color="green">136</FONT>             * Listens to client and converts input to objects of type {@link ServerMessageToClient}. Waits for input on the server<a name="line.136"></a>
<FONT color="green">137</FONT>             * {@link ServerEndpoint}. A thread is being used for this, since reading input is blocking, meaning the thread 'sleeps' while waiting<a name="line.137"></a>
<FONT color="green">138</FONT>             * for input. These messages are then added to the server stack for execution by external user.&lt;br /&gt;<a name="line.138"></a>
<FONT color="green">139</FONT>             * &lt;strong&gt;Note:&lt;/strong&gt; some messages are filtered by the server as they are of server level, such as ping messages.<a name="line.139"></a>
<FONT color="green">140</FONT>             * &lt;p&gt;<a name="line.140"></a>
<FONT color="green">141</FONT>             * Reuses fields from {@link ServerHandler}, such as {@link ServerHandler#client} and {@link ServerHandler#serverContext}. Keeps<a name="line.141"></a>
<FONT color="green">142</FONT>             * listening for input while the server is still running and the server hasn't dropped the connection.<a name="line.142"></a>
<FONT color="green">143</FONT>             * &lt;p&gt;<a name="line.143"></a>
<FONT color="green">144</FONT>             * The input data is read per line, so messages need to end with a newline character '\n'. Since clients need to conform to the lowest<a name="line.144"></a>
<FONT color="green">145</FONT>             * common denominator, they are required to append a zero (0) byte '\0' as per Flash clients. This character is appended to the newline<a name="line.145"></a>
<FONT color="green">146</FONT>             * '\n' character and needs to be discarded manually using a {@link BufferedReader#read()}.<a name="line.146"></a>
<FONT color="green">147</FONT>             * &lt;p&gt;<a name="line.147"></a>
<FONT color="green">148</FONT>             * Each complete line received serves as a datagram and is handled by {@link #handleMessage(String)}.<a name="line.148"></a>
<FONT color="green">149</FONT>             * <a name="line.149"></a>
<FONT color="green">150</FONT>             * @see #handleMessage(String)<a name="line.150"></a>
<FONT color="green">151</FONT>             * @see SwiftSocketClient#isRunning()<a name="line.151"></a>
<FONT color="green">152</FONT>             */<a name="line.152"></a>
<FONT color="green">153</FONT>            @Override<a name="line.153"></a>
<FONT color="green">154</FONT>            public void run() {<a name="line.154"></a>
<FONT color="green">155</FONT>                    while (client.isRunning() &amp;&amp; !serverContext.isServerSaidByeBye()) {<a name="line.155"></a>
<FONT color="green">156</FONT>                            try {<a name="line.156"></a>
<FONT color="green">157</FONT>                                    final String line = serverContext.getServerEndpoint().readLine();<a name="line.157"></a>
<FONT color="green">158</FONT>                                    if (client.isRunning()) {<a name="line.158"></a>
<FONT color="green">159</FONT>                                            if (line != null) {<a name="line.159"></a>
<FONT color="green">160</FONT>                                                    serverContext.getServerEndpoint().read();<a name="line.160"></a>
<FONT color="green">161</FONT>                                                    handleMessage(line);<a name="line.161"></a>
<FONT color="green">162</FONT>                                            } else {<a name="line.162"></a>
<FONT color="green">163</FONT>                                                    // server closed its connection the hard way<a name="line.163"></a>
<FONT color="green">164</FONT>                                                    LOGGER.debug(String.format("server %s closed connection non-gracefully", serverContext.getServerInetAddress()));<a name="line.164"></a>
<FONT color="green">165</FONT>                                                    serverContext.setServerSaidByeBye(true);<a name="line.165"></a>
<FONT color="green">166</FONT>                                                    client.removeServerHandler();<a name="line.166"></a>
<FONT color="green">167</FONT>                                                    break;<a name="line.167"></a>
<FONT color="green">168</FONT>                                            }<a name="line.168"></a>
<FONT color="green">169</FONT>                                    }<a name="line.169"></a>
<FONT color="green">170</FONT>                            } catch (final SocketException e) {<a name="line.170"></a>
<FONT color="green">171</FONT>                                    if (e.getMessage().equals(ERROR_SOCKET_CLOSED) || e.getMessage().equals(ERROR_RECV_FAILED)<a name="line.171"></a>
<FONT color="green">172</FONT>                                                    || e.getMessage().equals(ERROR_CONNECTION_RESET)) {<a name="line.172"></a>
<FONT color="green">173</FONT>                                            if (e.getMessage().equals(ERROR_SOCKET_CLOSED)) {<a name="line.173"></a>
<FONT color="green">174</FONT>                                                    final String msg = "tried to read or write to closed socket %s";<a name="line.174"></a>
<FONT color="green">175</FONT>                                                    LOGGER.error(String.format(msg, serverContext.getServerInetAddress()));<a name="line.175"></a>
<FONT color="green">176</FONT>                                            } else {<a name="line.176"></a>
<FONT color="green">177</FONT>                                                    final String msg = "socket in error state [%s] for server %s";<a name="line.177"></a>
<FONT color="green">178</FONT>                                                    LOGGER.error(String.format(msg, e.getMessage(), serverContext.getServerInetAddress()));<a name="line.178"></a>
<FONT color="green">179</FONT>                                            }<a name="line.179"></a>
<FONT color="green">180</FONT>                                            serverContext.setServerSaidByeBye(true);<a name="line.180"></a>
<FONT color="green">181</FONT>                                            client.removeServerHandler();<a name="line.181"></a>
<FONT color="green">182</FONT>                                            break;<a name="line.182"></a>
<FONT color="green">183</FONT>                                    }<a name="line.183"></a>
<FONT color="green">184</FONT>                                    // we have no clue what exception was thrown, just log the error and retry<a name="line.184"></a>
<FONT color="green">185</FONT>                                    LOGGER.error(e.getMessage(), e);<a name="line.185"></a>
<FONT color="green">186</FONT>                            } catch (final IOException e) {<a name="line.186"></a>
<FONT color="green">187</FONT>                                    // we have no clue what exception was thrown, just log the error and retry<a name="line.187"></a>
<FONT color="green">188</FONT>                                    LOGGER.error(e.getMessage(), e);<a name="line.188"></a>
<FONT color="green">189</FONT>                            }<a name="line.189"></a>
<FONT color="green">190</FONT>    <a name="line.190"></a>
<FONT color="green">191</FONT>                            ServerUtil.defaultSleep();<a name="line.191"></a>
<FONT color="green">192</FONT>                    }<a name="line.192"></a>
<FONT color="green">193</FONT>            }<a name="line.193"></a>
<FONT color="green">194</FONT>    <a name="line.194"></a>
<FONT color="green">195</FONT>            /**<a name="line.195"></a>
<FONT color="green">196</FONT>             * Handles a single server message string. Creates a {@link ServerMessageToClient} and adds this to the client message queue unless it<a name="line.196"></a>
<FONT color="green">197</FONT>             * is a server level message, such as a 'pong' notification, in which case the message is executed directly.<a name="line.197"></a>
<FONT color="green">198</FONT>             * <a name="line.198"></a>
<FONT color="green">199</FONT>             * @param datagramMessage The client message string, minus newline character '\n' and zero (0) byte '\0'.<a name="line.199"></a>
<FONT color="green">200</FONT>             * @see #createDecodedExecutableResponse(String)<a name="line.200"></a>
<FONT color="green">201</FONT>             * @see SwiftSocketClient#addServerResponse(ServerMessageToClient)<a name="line.201"></a>
<FONT color="green">202</FONT>             */<a name="line.202"></a>
<FONT color="green">203</FONT>            public void handleMessage(final String datagramMessage) {<a name="line.203"></a>
<FONT color="green">204</FONT>                    final ServerMessageToClient&lt;?&gt; response = createDecodedExecutableResponse(datagramMessage);<a name="line.204"></a>
<FONT color="green">205</FONT>                    determineLogger(response)<a name="line.205"></a>
<FONT color="green">206</FONT>                                    .debug(String.format("receiving response from %s: %s", serverContext, response.getClass().getSimpleName()));<a name="line.206"></a>
<FONT color="green">207</FONT>                    if (response instanceof ServerMessageToClientPingPong) {<a name="line.207"></a>
<FONT color="green">208</FONT>                            ((ServerMessageToClientPingPong) response).execute(ServerHandler.this);<a name="line.208"></a>
<FONT color="green">209</FONT>                    } else {<a name="line.209"></a>
<FONT color="green">210</FONT>                            client.addServerResponse(response);<a name="line.210"></a>
<FONT color="green">211</FONT>                    }<a name="line.211"></a>
<FONT color="green">212</FONT>            }<a name="line.212"></a>
<FONT color="green">213</FONT>    <a name="line.213"></a>
<FONT color="green">214</FONT>            /**<a name="line.214"></a>
<FONT color="green">215</FONT>             * Parses the raw server message into a message id and message content. Passes both values to<a name="line.215"></a>
<FONT color="green">216</FONT>             * {@link #createDecodedExecutableMessage(int, String)} and returns the result. The first {@value #MESSAGEID_LENGTH} bytes of the raw<a name="line.216"></a>
<FONT color="green">217</FONT>             * message denote the message code.<a name="line.217"></a>
<FONT color="green">218</FONT>             * &lt;p&gt;<a name="line.218"></a>
<FONT color="green">219</FONT>             * In case anything goes wrong, a {@link ServerMessageToClientInvalid} object is returned instead which generates some useful message<a name="line.219"></a>
<FONT color="green">220</FONT>             * for logging purposes. The server user can choose to filter out unknown messages at its own discretion. If a<a name="line.220"></a>
<FONT color="green">221</FONT>             * &lt;code&gt;ServerMessageToClientInvalid&lt;/code&gt; is executed however, it will throw a runtime exception with the original message.<a name="line.221"></a>
<FONT color="green">222</FONT>             * <a name="line.222"></a>
<FONT color="green">223</FONT>             * @param datagramMessage The server input string that represents a single message.<a name="line.223"></a>
<FONT color="green">224</FONT>             * @return {@link #createDecodedExecutableMessage(int, String)}<a name="line.224"></a>
<FONT color="green">225</FONT>             * @see #createInvalidMessage(String, Exception, String)<a name="line.225"></a>
<FONT color="green">226</FONT>             */<a name="line.226"></a>
<FONT color="green">227</FONT>            protected ServerMessageToClient&lt;?&gt; createDecodedExecutableResponse(final String datagramMessage) {<a name="line.227"></a>
<FONT color="green">228</FONT>                    final int responseCode;<a name="line.228"></a>
<FONT color="green">229</FONT>                    try {<a name="line.229"></a>
<FONT color="green">230</FONT>                            responseCode = Integer.parseInt(datagramMessage.substring(0, MESSAGEID_LENGTH));<a name="line.230"></a>
<FONT color="green">231</FONT>                    } catch (final NumberFormatException e) {<a name="line.231"></a>
<FONT color="green">232</FONT>                            return createInvalidMessage(datagramMessage, e, "invalid response identifier");<a name="line.232"></a>
<FONT color="green">233</FONT>                    }<a name="line.233"></a>
<FONT color="green">234</FONT>                    final String responseBody = datagramMessage.substring(MESSAGEID_LENGTH);<a name="line.234"></a>
<FONT color="green">235</FONT>                    return createDecodedExecutableMessage(responseCode, responseBody);<a name="line.235"></a>
<FONT color="green">236</FONT>            }<a name="line.236"></a>
<FONT color="green">237</FONT>    <a name="line.237"></a>
<FONT color="green">238</FONT>            /**<a name="line.238"></a>
<FONT color="green">239</FONT>             * Creates a {@link ServerMessageToClient} instance based on the message id and message content.<a name="line.239"></a>
<FONT color="green">240</FONT>             * <a name="line.240"></a>
<FONT color="green">241</FONT>             * @param messageId The identifier for the message type we need to instantiate.<a name="line.241"></a>
<FONT color="green">242</FONT>             * @param messageContent The message content for the solved message type to decode.<a name="line.242"></a>
<FONT color="green">243</FONT>             * @return A {@link ServerMessageToClient} with identified by &lt;code&gt;messageId&lt;/code&gt; decoded from &lt;code&gt;messageContent&lt;/code&gt;.<a name="line.243"></a>
<FONT color="green">244</FONT>             * @see SwiftSocketClient#getServerMessageToClientType(int)<a name="line.244"></a>
<FONT color="green">245</FONT>             * @see ServerMessageToClient#decode(String)<a name="line.245"></a>
<FONT color="green">246</FONT>             */<a name="line.246"></a>
<FONT color="green">247</FONT>            private final ServerMessageToClient&lt;?&gt; createDecodedExecutableMessage(final int messageId, final String messageContent) {<a name="line.247"></a>
<FONT color="green">248</FONT>                    final Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; responseType = client.getServerMessageToClientType(messageId);<a name="line.248"></a>
<FONT color="green">249</FONT>                    ServerMessageToClient&lt;?&gt; response;<a name="line.249"></a>
<FONT color="green">250</FONT>                    try {<a name="line.250"></a>
<FONT color="green">251</FONT>                            response = responseType.newInstance();<a name="line.251"></a>
<FONT color="green">252</FONT>                    } catch (final IllegalAccessException e) {<a name="line.252"></a>
<FONT color="green">253</FONT>                            return createInvalidMessage(messageContent, e, "constructor not visible for message");<a name="line.253"></a>
<FONT color="green">254</FONT>                    } catch (final InstantiationException e) {<a name="line.254"></a>
<FONT color="green">255</FONT>                            return createInvalidMessage(messageContent, e, "unable to construct message");<a name="line.255"></a>
<FONT color="green">256</FONT>                    }<a name="line.256"></a>
<FONT color="green">257</FONT>                    response.decode(messageContent);<a name="line.257"></a>
<FONT color="green">258</FONT>                    return response;<a name="line.258"></a>
<FONT color="green">259</FONT>            }<a name="line.259"></a>
<FONT color="green">260</FONT>    <a name="line.260"></a>
<FONT color="green">261</FONT>            /**<a name="line.261"></a>
<FONT color="green">262</FONT>             * Generates a {@link ServerMessageToClientInvalid} object with the failure cause. When executed, this message throws a runtime<a name="line.262"></a>
<FONT color="green">263</FONT>             * exception with the original exception.<a name="line.263"></a>
<FONT color="green">264</FONT>             * <a name="line.264"></a>
<FONT color="green">265</FONT>             * @param originalMessage The original message<a name="line.265"></a>
<FONT color="green">266</FONT>             * @param failureCause The exception that occurred when the original messages was being converted into a {@link ServerMessageToClient}.<a name="line.266"></a>
<FONT color="green">267</FONT>             * @param cause A fine grained exception description when the exception &lt;code&gt;failureCause&lt;/code&gt; occurred.<a name="line.267"></a>
<FONT color="green">268</FONT>             * @return An instance of {@link ServerMessageToClientInvalid}.<a name="line.268"></a>
<FONT color="green">269</FONT>             */<a name="line.269"></a>
<FONT color="green">270</FONT>            private ServerMessageToClient&lt;?&gt; createInvalidMessage(final String originalMessage, final Exception failureCause, final String cause) {<a name="line.270"></a>
<FONT color="green">271</FONT>                    final ServerMessageToClientInvalid response = new ServerMessageToClientInvalid(serverContext, failureCause);<a name="line.271"></a>
<FONT color="green">272</FONT>                    response.decode(String.format("%s (original response: '%s')", cause, originalMessage));<a name="line.272"></a>
<FONT color="green">273</FONT>                    return response;<a name="line.273"></a>
<FONT color="green">274</FONT>            }<a name="line.274"></a>
<FONT color="green">275</FONT>    }<a name="line.275"></a>




























































</PRE>
</BODY>
</HTML>
